eFAWATEERcom BANK API icon

eFAWATEERcom BANK API

(0 reviews)

Remove Customer Billing

URLs :

Endpoint : HTTPS://<host>:<port>/efawateercom-bank-api/v1/customer/postpaid/remove-customer-billing

Method : POST

Description : This service allows the channel or Bank itself to remove a Postpaid billing account for a particular customer with biller information.

Channels or Bank that want to remove Postpaid billing account for a customer will pass the Remove postpaid customer Billing request to the mule service, mule service will in turn call the eFAWATEERcom endpoint to remove the Postpaid billing account and eFAWATEERcom will remove the billing account for that customer.

Mulesoft Request:

Mandatory Headers: x-channel-id,x-client-trace-id, x-bank-id,client_id, client_secret

Optional Headers: x-sub-channel-id, x-user-id, Authorization, x-debug-flag, x-customer-id

Request Body: application/json

Field NameTypeLengthOccurrenceDescription
removeCustomerBillingObjectM
acctObjectM
joebppsNointeger10Represents the unique identifier of the customer profile in eFAWATEERcom
billingsRecObjectM
billingRecObject
billerCodeInteger3MRepresents the unique code of the Biller
billingNostring50MRepresents the unique identifier of subscription in a specific service provided by the biller
serviceTypestring25MRepresents the service type of the biller
End of billingRec
End of billingsRec
End of acct
End of removeCustomerBilling
{
"removeCustomerBilling": {
"acct": {
"joebppsNo": "3172312341232",
"billingsRec": {
"billingRec": {
"billerCode": "13",
"billingNo": "07999999999",
"serviceType": "Electricity"
}
}
}
}
}

Mulesoft Response:

Success Response: (200)

Response Body: application/json

Field NameTypeLengthOccurrenceDescriptionValidation
statusObjectM
successBooleanMtrue false
codeString10MError Code“0” incase of success or Error Code
reasonCodeString50OError Type or Error categoryAdd this tag only incase of error
arabicMessageString200MEnglish message translated to Arabicتمت العملية بنجاح in case of success or arabic translated error in case of known errors
englishMessageString200MDescription about the processing“The Operation has been Successfully Completed” Or error Description
End of status
responseObjectOExists if success = true
removeCustomerBillingObjectM
acctObjectM
joebppsNoInteger10Represents the unique identifier of the customer profile in eFAWATEERcom
resultObjectM
errorCodestring3M
errorDescstring100M
severityEnum, string7MEnum: Error, Info
End of result
billingsRecObjectM
billingRecobjectM
billerCodeInteger3MRepresents the unique code of the Biller
billingNostring50MRepresents the unique identifier of subscription in a specific service provided by the biller
serviceTypestring25MRepresents the service type of the biller
resultObjectM
errorCodestring3M
errorDescstring100M
severityEnum, string7MEnum: Error, Info
End of result
End of billingRec
End of billingsRec
End of acct
End of removeCustomerBilling
End of response
{
"status": {
"success": true,
"code": "200",
"arabicMessage": "تمت العملية بنجاح",
"englishMessage": "The Operation has been Successfully Completed"
},
"response": {
"removeCustomerBilling": {
"acct": {
"joebppsNo": "3172312341232",
"result": {
"errorCode": "0",
"errorDesc": "Success",
"severity": "Info"
},
"billingsRec": {
"billingRec": {
"billerCode": "13",
"billingNo": "07999999999",
"serviceType": "Electricity",
"result": {
"errorCode": "0",
"errorDesc": "Success",
"severity": "Info"
}
}
}
}
}
}
}

Sample Error Response:

Error codes :

400:

content-type: JSON

{
"success": false,
"code": "400",
"reasonCode": "Bad Request",
"arabicMessage": "اقتراح غير جي",
"englishMessage": "joebppsNo invalid"
}

Reviews